﻿#region Legal

// Jimmy Zimmerman
// Team Mongoose
//
// END USER LICENSE AGREEMENT
// IMPORTANT - READ THIS CAREFULLY:  This End User License Agreement is a legal agreement
// between you (either an individual, business entity, currently active identity of an
// individual with Multiple Personality Disorder, octopus overlord, or otherworldly entity),
// and Team Mongoose, for the enclosed, components.
//
// By reading this document and/or installing this product, you agree to be bound by the
// terms of this EULA.
//
// Team Mongoose owns all copyright, trade secret, trademark, trade wars,
// patent, portent, and potential rights to these components.  Team Mongoose
// grants you the right to deploy the enclosed components.
//
// If you agree to the terms of this EULA, a license to use these components is granted to you.
//
// If you should happen to benefit from the enclosed components, then you are legally and
// contractually bound to thank us for it. Send your regards to jimmyzimms@hotmail.com.
//
// OTHER RIGHTS AND LIMITATONS
// You may not reverse-engineer, decompile, decode, disassemble, psycho-analyze, or otherwise
// attempt to find hidden meanings between the lines of this EULA; unless, of course, you should
// happen to find some, and they are funny.
//
// You may not translate this EULA or any part of the components into Ancient Sumerian.
//
// THESE COMPONENTS ARE PROVIDED “AS-IS” WITHOUT WARRANTY OF ANY KIND. ANY USE OF THE COMPONENTS
// CONTAINED IS AT YOUR OWN RISK. TEAM MONGOOSE DISCLAIM ALL WARRANTIES, EITHER
// EXPRESS OR IMPLIED, WITH RESPECT TO THE ACCURRACY AND CORRECTNESS OF THE COMPONENTS CONTAINED
// HEREIN. TEAM MONGOOSE DOES NOT WARRANT THAT THE COMPONENTS ARE FLAWLESS.
//
// REDISTRIBUTION AND USE IN SOURCE AND BINARY FORMS, WITH OR WITHOUT MODIFICATION, ARE PERMITTED
// PROVIDED THAT THE FOLLOWING CONDITIONS ARE MET:
// * REDISTRIBUTIONS OF SOURCE CODE MUST RETAIN THE ABOVE COPYRIGHT NOTICE
// * REDISTRIBUTIONS IN BINARY FORM MUST NOTE THE USE OF THE COMPONENT IN DOCUMENTATION AND/OR
//   OTHER MATERIALS PROVIDED WITH THE DISTRIBUTION.
// * NEITHER THE NAME OF TEAM MONGOOSE MAY BE USED TO ENDORES OR PROMOTE PRODUCTS
//   DERIVED FROM THIS SOFTWARE WITHOUT SPECIFIC PRIOR WRITTEN PERMISSION.
//
// IN NO EVENT SHALL TEAM MONGOOSE BE HELD LIABLE FOR INCIDENTAL, SPECIAL, INDIRECT,
// INCONSEQUENTIAL, UNBELIEVABLE, EXAGGERATED, VERBOSE, OR TYPICAL DAMAGES INCURRED WHILE USING
// THE ENCLOSED COMPONENTS.
//
// OUR STUFF ALWAYS WORKS - SOMETIMES.

#endregion

using System;
using System.ComponentModel;

namespace DiceRoller.Dice
{
    /// <summary>
    /// The basic default implementation of a <see cref="Die"/> based on a numeric bounded number from 1 to N.
    /// This type is suitable for almost all standard use cases of the <see cref="Die"/> type and supports
    /// <see cref="INotifyPropertyChanged">change notification</see>.
    /// </summary>
    public class BoundedDie : Die, INotifyPropertyChanged
    {
        #region Fields

        private Int32? lastRoll;

        #endregion
        
        #region Constructors

        /// <summary>
        /// Initializes a new instance of the <see cref="BoundedDie"/> class with the indicated <see cref="Die.MaximumValue"/> setting and leveraging the default minimum value of 1.
        /// </summary>
        /// <param name="maxValue">The maximum value the die can select. This is any value greater than 1.</param>
        /// <exception cref="ArgumentOutOfRangeException"><paramref name="maxValue"/> is less than or equal to 1.</exception>
        public BoundedDie(int maxValue) : base(maxValue)
        {
        }

        #endregion

        #region Properties

        /// <summary>
        /// Gets or sets the value of the last roll of the die.
        /// </summary>
        /// <remarks>
        /// Setting this property will raise the <see cref="PropertyChanged"/> event. This will occur
        /// even if the value being set equals the previous value thus making the <seealso cref="PropertyChanged"/>
        /// event synonmous with a <see cref="Roll"/> of the die.</remarks>
        /// <value>An <see cref="Int32"/> representing the last roll value or <see cref="Die.MinimumValue"/> if never rolled.</value>
        /// <exception cref="ArgumentOutOfRangeException">The supplied value is less than <see cref="Die.MinimumValue"/> or greater than <see cref="Die.MaximumValue"/>.</exception>
        public virtual Int32 LastRoll
        {
            get
            {
                if (!this.lastRoll.HasValue)
                {
                    return this.MinimumValue;
                }

                return this.lastRoll.Value;
            }
            protected set
            {
                if (value < this.MinimumValue) throw new ArgumentOutOfRangeException(String.Format(null, "The supplied value '{0}' is less than the minimum value for this die '{1}'", value, this.MinimumValue));
                if (value > this.MaximumValue) throw new ArgumentOutOfRangeException(String.Format(null, "The supplied value '{0}' is less than the maximum value for this die '{1}'", value, this.MaximumValue));

                this.lastRoll = value;
                this.OnPropertyChanged("LastRoll");
            }
        }

        #endregion

        #region Overrides

        /// <summary>
        /// Rolls the current <see cref="Die"/> instance and returns the result.
        /// </summary>
        /// <remarks>This method will set the <see cref="LastRoll"/> property value.</remarks>
        /// <returns>The result of the random roll.</returns>
        public override int Roll()
        {
            var roll = this.RandomGenerator.Next(this.MinimumValue, this.MaximumValue);

            this.LastRoll = roll;

            return roll;
        }

        #endregion

        #region INotifyPropertyChanged Members

        /// <summary>
        /// An event signaling the update and or change to a public facing property.
        /// </summary>
        public event PropertyChangedEventHandler PropertyChanged;

        /// <summary>
        /// Raises the <see cref="PropertyChanged"/> event.
        /// </summary>
        /// <param name="changed">The name of the property that changed.</param>
        protected virtual void OnPropertyChanged(string changed)
        {
            if (this.PropertyChanged == null) return;
            
            this.PropertyChanged(this, new PropertyChangedEventArgs(changed));
        }

        #endregion
    }
}
